

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Best practices &mdash; rosjava_core 0.1.6 documentation</title>
    
    <link rel="stylesheet" href="_static/haiku.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/print.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '0.1.6',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="_static/theme_extras.js"></script>
    <link rel="top" title="rosjava_core 0.1.6 documentation" href="index.html" />
    <link rel="next" title="Getting started" href="getting_started.html" />
    <link rel="prev" title="Building" href="building.html" /> 
  </head>
  <body>
      <div class="header"><h1 class="heading"><a href="index.html">
          <span>rosjava_core 0.1.6 documentation</span></a></h1>
        <h2 class="heading"><span>Best practices</span></h2>
      </div>
      <div class="topnav">
      
        <p>
        «&#160;&#160;<a href="building.html">Building</a>
        &#160;&#160;::&#160;&#160;
        <a class="uplink" href="index.html">Contents</a>
        &#160;&#160;::&#160;&#160;
        <a href="getting_started.html">Getting started</a>&#160;&#160;»
        </p>

      </div>
      <div class="content">
        
        
  <div class="section" id="best-practices">
<h1>Best practices<a class="headerlink" href="#best-practices" title="Permalink to this headline">¶</a></h1>
<p>rosjava is different than other ROS client libraries in many respects. As a
result, there are new best practices that should be followed while developing a
rosjava application.</p>
<div class="section" id="java-package-names">
<h2>Java package names<a class="headerlink" href="#java-package-names" title="Permalink to this headline">¶</a></h2>
<p>As usual, Java package names should start with a reversed domain name. In the
ROS ecosystem, the domain name should be followed by the ROS package name. For
example:</p>
<ul class="simple">
<li>org.ros.rosjava</li>
<li>org.ros.rosjava_geometry</li>
</ul>
<p>Only core packages (e.g. those in rosjava_core and android_core) should begin
with org.ros. A suitably unique choice for github based repos would be
the github url followed organization and repository/package name, e.g.</p>
<ul class="simple">
<li>com.github.rosjava.rosjava_extras</li>
</ul>
</div>
</div>


      </div>
      <div class="bottomnav">
      
        <p>
        «&#160;&#160;<a href="building.html">Building</a>
        &#160;&#160;::&#160;&#160;
        <a class="uplink" href="index.html">Contents</a>
        &#160;&#160;::&#160;&#160;
        <a href="getting_started.html">Getting started</a>&#160;&#160;»
        </p>

      </div>

    <div class="footer">
        &copy; Copyright 2013, Google, Inc..
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    </div>
  </body>
</html>